home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / AIncludes / Threads.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  10.6 KB  |  402 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        Threads.a
  3. ;
  4. ;    Contains:    Thread Manager Interfaces.
  5. ;
  6. ;    Version:    Technology:    Mac OS 8
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1991-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__THREADS__') = 'UNDEFINED' THEN
  18. __THREADS__ SET 1
  19.  
  20.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  21.     include 'MacTypes.a'
  22.     ENDIF
  23.     IF &TYPE('__MIXEDMODE__') = 'UNDEFINED' THEN
  24.     include 'MixedMode.a'
  25.     ENDIF
  26.     IF &TYPE('__ERRORS__') = 'UNDEFINED' THEN
  27.     include 'Errors.a'
  28.     ENDIF
  29.  
  30. ;  Thread states 
  31. ; typedef unsigned short                 ThreadState
  32.  
  33.  
  34. kReadyThreadState                EQU        0
  35. kStoppedThreadState                EQU        1
  36. kRunningThreadState                EQU        2
  37. ;  Error codes have been meoved to Errors.(pah) 
  38. ;  Thread environment characteristics 
  39. ; typedef void *                        ThreadTaskRef
  40.  
  41. ;  Thread characteristics 
  42. ; typedef unsigned long                 ThreadStyle
  43.  
  44.  
  45. kCooperativeThread                EQU        $00000001
  46. kPreemptiveThread                EQU        $00000002
  47. ;  Thread identifiers 
  48. ; typedef unsigned long                 ThreadID
  49.  
  50.  
  51. kNoThreadID                        EQU        0
  52. kCurrentThreadID                EQU        1
  53. kApplicationThreadID            EQU        2
  54. ;  Options when creating a thread 
  55. ; typedef unsigned long                 ThreadOptions
  56.  
  57.  
  58. kNewSuspend                        EQU        $01
  59. kUsePremadeThread                EQU        $02
  60. kCreateIfNeeded                    EQU        $04
  61. kFPUNotNeeded                    EQU        $08
  62. kExactMatchThread                EQU        $10
  63. ;  Information supplied to the custom scheduler 
  64. SchedulerInfoRec        RECORD 0
  65. InfoRecSize                 ds.l    1                ; offset: $0 (0)
  66. CurrentThreadID             ds.l    1                ; offset: $4 (4)
  67. SuggestedThreadID         ds.l    1                ; offset: $8 (8)
  68. InterruptedCoopThreadID     ds.l    1                ; offset: $C (12)
  69. sizeof                     EQU *                    ; size:   $10 (16)
  70.                         ENDR
  71. ; typedef struct SchedulerInfoRec *        SchedulerInfoRecPtr
  72.  
  73.  
  74.     IF TARGET_CPU_68K ** TARGET_RT_MAC_CFM THEN
  75. ; 
  76. ;    The following UniversalProcPtrs are for CFM-68k compatiblity with
  77. ;    the implementation of the Thread Manager.
  78. ;
  79.  
  80. ; typedef UniversalProcPtr                 ThreadEntryProcPtr
  81.  
  82. ; typedef UniversalProcPtr                 ThreadSchedulerProcPtr
  83.  
  84. ; typedef UniversalProcPtr                 ThreadSwitchProcPtr
  85.  
  86. ; typedef UniversalProcPtr                 ThreadTerminationProcPtr
  87.  
  88. ; typedef UniversalProcPtr                 DebuggerNewThreadProcPtr
  89.  
  90. ; typedef UniversalProcPtr                 DebuggerDisposeThreadProcPtr
  91.  
  92. ; typedef UniversalProcPtr                 DebuggerThreadSchedulerProcPtr
  93.  
  94.     ELSE
  95. ; 
  96. ;    The following ProcPtrs cannot be interchanged with UniversalProcPtrs because
  97. ;    of differences between 680x0 and PowerPC runtime architectures with regard to
  98. ;    the implementation of the Thread Manager.
  99. ; 
  100.  
  101. ;  Prototype for thread's entry (main) routine 
  102. ; typedef void *                        voidPtr
  103.  
  104. ;  Prototype for custom thread scheduler routine 
  105. ;  Prototype for custom thread switcher routine 
  106. ;  Prototype for thread termination notification routine 
  107. ;  Prototype for debugger NewThread notification 
  108. ;  Prototype for debugger DisposeThread notification 
  109. ;  Prototype for debugger schedule notification 
  110.     ENDIF
  111.  
  112. ;  Thread Manager routines 
  113. ;
  114. ; pascal OSErr CreateThreadPool(ThreadStyle threadStyle, short numToCreate, Size stackSize)
  115. ;
  116.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  117.         Macro
  118.         _CreateThreadPool
  119.             move.w              #$0501,D0
  120.             dc.w                $ABF2
  121.         EndM
  122.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  123.         IMPORT_CFM_FUNCTION CreateThreadPool
  124.     ENDIF
  125.  
  126. ;
  127. ; pascal OSErr GetFreeThreadCount(ThreadStyle threadStyle, short *freeCount)
  128. ;
  129.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  130.         Macro
  131.         _GetFreeThreadCount
  132.             move.w              #$0402,D0
  133.             dc.w                $ABF2
  134.         EndM
  135.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  136.         IMPORT_CFM_FUNCTION GetFreeThreadCount
  137.     ENDIF
  138.  
  139. ;
  140. ; pascal OSErr GetSpecificFreeThreadCount(ThreadStyle threadStyle, Size stackSize, short *freeCount)
  141. ;
  142.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  143.         Macro
  144.         _GetSpecificFreeThreadCount
  145.             move.w              #$0615,D0
  146.             dc.w                $ABF2
  147.         EndM
  148.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  149.         IMPORT_CFM_FUNCTION GetSpecificFreeThreadCount
  150.     ENDIF
  151.  
  152. ;
  153. ; pascal OSErr GetDefaultThreadStackSize(ThreadStyle threadStyle, Size *stackSize)
  154. ;
  155.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  156.         Macro
  157.         _GetDefaultThreadStackSize
  158.             move.w              #$0413,D0
  159.             dc.w                $ABF2
  160.         EndM
  161.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  162.         IMPORT_CFM_FUNCTION GetDefaultThreadStackSize
  163.     ENDIF
  164.  
  165. ;
  166. ; pascal OSErr ThreadCurrentStackSpace(ThreadID thread, unsigned long *freeStack)
  167. ;
  168.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  169.         Macro
  170.         _ThreadCurrentStackSpace
  171.             move.w              #$0414,D0
  172.             dc.w                $ABF2
  173.         EndM
  174.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  175.         IMPORT_CFM_FUNCTION ThreadCurrentStackSpace
  176.     ENDIF
  177.  
  178. ;
  179. ; pascal OSErr NewThread(ThreadStyle threadStyle, ThreadEntryProcPtr threadEntry, void *threadParam, Size stackSize, ThreadOptions options, void **threadResult, ThreadID *threadMade)
  180. ;
  181.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  182.         Macro
  183.         _NewThread
  184.             move.w              #$0E03,D0
  185.             dc.w                $ABF2
  186.         EndM
  187.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  188.         IMPORT_CFM_FUNCTION NewThread
  189.     ENDIF
  190.  
  191. ;
  192. ; pascal OSErr DisposeThread(ThreadID threadToDump, void *threadResult, Boolean recycleThread)
  193. ;
  194.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  195.         Macro
  196.         _DisposeThread
  197.             move.w              #$0504,D0
  198.             dc.w                $ABF2
  199.         EndM
  200.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  201.         IMPORT_CFM_FUNCTION DisposeThread
  202.     ENDIF
  203.  
  204. ;
  205. ; pascal OSErr YieldToThread(ThreadID suggestedThread)
  206. ;
  207.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  208.         Macro
  209.         _YieldToThread
  210.             move.w              #$0205,D0
  211.             dc.w                $ABF2
  212.         EndM
  213.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  214.         IMPORT_CFM_FUNCTION YieldToThread
  215.     ENDIF
  216.  
  217. ;
  218. ; pascal OSErr YieldToAnyThread(void )
  219. ;
  220.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  221.         Macro
  222.         _YieldToAnyThread
  223.             clr.l               -(sp)
  224.             move.w              #$0205,D0
  225.             dc.w                $ABF2
  226.         EndM
  227.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  228.         IMPORT_CFM_FUNCTION YieldToAnyThread
  229.     ENDIF
  230.  
  231. ;
  232. ; pascal OSErr GetCurrentThread(ThreadID *currentThreadID)
  233. ;
  234.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  235.         Macro
  236.         _GetCurrentThread
  237.             move.w              #$0206,D0
  238.             dc.w                $ABF2
  239.         EndM
  240.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  241.         IMPORT_CFM_FUNCTION GetCurrentThread
  242.     ENDIF
  243.  
  244. ;
  245. ; pascal OSErr GetThreadState(ThreadID threadToGet, ThreadState *threadState)
  246. ;
  247.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  248.         Macro
  249.         _GetThreadState
  250.             move.w              #$0407,D0
  251.             dc.w                $ABF2
  252.         EndM
  253.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  254.         IMPORT_CFM_FUNCTION GetThreadState
  255.     ENDIF
  256.  
  257. ;
  258. ; pascal OSErr SetThreadState(ThreadID threadToSet, ThreadState newState, ThreadID suggestedThread)
  259. ;
  260.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  261.         Macro
  262.         _SetThreadState
  263.             move.w              #$0508,D0
  264.             dc.w                $ABF2
  265.         EndM
  266.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  267.         IMPORT_CFM_FUNCTION SetThreadState
  268.     ENDIF
  269.  
  270. ;
  271. ; pascal OSErr SetThreadStateEndCritical(ThreadID threadToSet, ThreadState newState, ThreadID suggestedThread)
  272. ;
  273.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  274.         Macro
  275.         _SetThreadStateEndCritical
  276.             move.w              #$0512,D0
  277.             dc.w                $ABF2
  278.         EndM
  279.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  280.         IMPORT_CFM_FUNCTION SetThreadStateEndCritical
  281.     ENDIF
  282.  
  283. ;
  284. ; pascal OSErr SetThreadScheduler(ThreadSchedulerProcPtr threadScheduler)
  285. ;
  286.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  287.         Macro
  288.         _SetThreadScheduler
  289.             move.w              #$0209,D0
  290.             dc.w                $ABF2
  291.         EndM
  292.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  293.         IMPORT_CFM_FUNCTION SetThreadScheduler
  294.     ENDIF
  295.  
  296. ;
  297. ; pascal OSErr SetThreadSwitcher(ThreadID thread, ThreadSwitchProcPtr threadSwitcher, void *switchProcParam, Boolean inOrOut)
  298. ;
  299.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  300.         Macro
  301.         _SetThreadSwitcher
  302.             move.w              #$070A,D0
  303.             dc.w                $ABF2
  304.         EndM
  305.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  306.         IMPORT_CFM_FUNCTION SetThreadSwitcher
  307.     ENDIF
  308.  
  309. ;
  310. ; pascal OSErr SetThreadTerminator(ThreadID thread, ThreadTerminationProcPtr threadTerminator, void *terminationProcParam)
  311. ;
  312.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  313.         Macro
  314.         _SetThreadTerminator
  315.             move.w              #$0611,D0
  316.             dc.w                $ABF2
  317.         EndM
  318.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  319.         IMPORT_CFM_FUNCTION SetThreadTerminator
  320.     ENDIF
  321.  
  322. ;
  323. ; pascal OSErr ThreadBeginCritical(void )
  324. ;
  325.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  326.         Macro
  327.         _ThreadBeginCritical
  328.             move.w              #$000B,D0
  329.             dc.w                $ABF2
  330.         EndM
  331.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  332.         IMPORT_CFM_FUNCTION ThreadBeginCritical
  333.     ENDIF
  334.  
  335. ;
  336. ; pascal OSErr ThreadEndCritical(void )
  337. ;
  338.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  339.         Macro
  340.         _ThreadEndCritical
  341.             move.w              #$000C,D0
  342.             dc.w                $ABF2
  343.         EndM
  344.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  345.         IMPORT_CFM_FUNCTION ThreadEndCritical
  346.     ENDIF
  347.  
  348. ;
  349. ; pascal OSErr SetDebuggerNotificationProcs(DebuggerNewThreadProcPtr notifyNewThread, DebuggerDisposeThreadProcPtr notifyDisposeThread, DebuggerThreadSchedulerProcPtr notifyThreadScheduler)
  350. ;
  351.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  352.         Macro
  353.         _SetDebuggerNotificationProcs
  354.             move.w              #$060D,D0
  355.             dc.w                $ABF2
  356.         EndM
  357.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  358.         IMPORT_CFM_FUNCTION SetDebuggerNotificationProcs
  359.     ENDIF
  360.  
  361. ;
  362. ; pascal OSErr GetThreadCurrentTaskRef(ThreadTaskRef *threadTRef)
  363. ;
  364.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  365.         Macro
  366.         _GetThreadCurrentTaskRef
  367.             move.w              #$020E,D0
  368.             dc.w                $ABF2
  369.         EndM
  370.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  371.         IMPORT_CFM_FUNCTION GetThreadCurrentTaskRef
  372.     ENDIF
  373.  
  374. ;
  375. ; pascal OSErr GetThreadStateGivenTaskRef(ThreadTaskRef threadTRef, ThreadID threadToGet, ThreadState *threadState)
  376. ;
  377.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  378.         Macro
  379.         _GetThreadStateGivenTaskRef
  380.             move.w              #$060F,D0
  381.             dc.w                $ABF2
  382.         EndM
  383.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  384.         IMPORT_CFM_FUNCTION GetThreadStateGivenTaskRef
  385.     ENDIF
  386.  
  387. ;
  388. ; pascal OSErr SetThreadReadyGivenTaskRef(ThreadTaskRef threadTRef, ThreadID threadToSet)
  389. ;
  390.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  391.         Macro
  392.         _SetThreadReadyGivenTaskRef
  393.             move.w              #$0410,D0
  394.             dc.w                $ABF2
  395.         EndM
  396.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  397.         IMPORT_CFM_FUNCTION SetThreadReadyGivenTaskRef
  398.     ENDIF
  399.  
  400.     ENDIF ; __THREADS__ 
  401.  
  402.